package web.suzy.oj.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Profile;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

/**
 * YangSuzy 软件工作室
 * 类名: SwaggerConfig
 * 描述: Swagger文档配置类
 * 功能: ---- 待定 -----
 *
 * @author YangSuzy
 * Date: 2022/11/9 23:08
 */
@Configuration
@EnableSwagger2 // 开启swagger2
@Profile({"dev", "test"}) // 只允许开发环境访问
public class SwaggerConfig {

    /**
     * 方法名: docket
     * 描述: 配置SwaggerAPI文档生成
     *
     * @param environment
     * @return springfox.documentation.spring.web.plugins.Docket
     * @date 2022/11/9 23:13
     * @auther YangSuzy
     **/
    @Bean
    public Docket docket(Environment environment) {
        //设置要显示的swagger环境(线下)
        Profiles profiles = Profiles.of("dev", "test");
        //通过环境判断是否在自己所设定的环境当中
        boolean flag = environment.acceptsProfiles(profiles);
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //分组
                .groupName("suzyoj")
                //根据当前环境开启文档访问
                .enable(true)
                .select()
                //RequestHandlerSelectors扫描方式
                //any()全部
                //none 都不扫描
                //path 过滤什么路径
                .apis(RequestHandlerSelectors.basePackage("web.suzy"))
                .build();
    }

    /**
     * 方法名: apiInfo
     * 描述: 配置swagger信息
     *
     * @return springfox.documentation.service.ApiInfo
     * @date 2022/11/9 23:09
     * @auther YangSuzy
     **/
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("SuzyOJ-Backend的API文档")
                .description("Suzy ONLINE JUDGE(SuzyOJ)的后端接口文档")
                .contact("YangSuzy")
                .version("v1.0")
                .build();
    }
}
